草庐IT

php - 文档格式

全部标签

ruby - 使用 YARD for Ruby 文档的内部评论?

我正在将我维护的ruby​​gem从RDoc切换到YARD文档。但是,代码中有一些关键注释只需要保留在代码中,不应出现在文档中。例如:###SomeClassdocumentationhere.#--#CRITICALcommentthatshouldbeinthecodebutnotinthedocumentation,#andmustbeatthisparticularspotinthecode.#++#moredocumentationthatfollowsthecriticalcommentblock,butthispart#shouldbeinthegenerateddocu

ruby-on-rails - REST API 文档生成

是否有库提供用于编写​​RESTAPI文档的标记?我见过几家公司使用类似的文档模式,例如:http://api.teamlab.com/2.0/http://www.fullcontact.com/docs/?category=person我想知道他们是否使用相同的库或服务。本质上,该库应该根据标记文本生成用于API导航、搜索和显示的页面(很像用于ruby​​文档的YARD)。这是我目前发现的:rapi_docgem.这是一个article讨论用法。 最佳答案 你绝对应该看看Swagger.它是开源的,被数百个API使用,也被3sc

【Elasticsearch基础】Elasticsearch索引、文档以及映射操作详解

文章目录概念索引相关操作创建索引更新副本查看索引删除索引索引的打开与关闭收缩索引索引别名查询索引别名文档相关操作新建文档查询文档更新文档删除文档映射相关操作查询文档映射创建静态映射创建索引并添加映射概念es中有三个概念要清楚,分别为索引、映射和文档(不用死记硬背,大概有个印象就可以)索引可理解为MySQL数据库;映射可理解为MySQL的表结构;文档可理解为MySQL表中的每行数据静态映射和动态映射上面已经介绍了,映射可理解为MySQL的表结构,在MySQL中,向表中插入数据是需要先创建表结构的;但在es中不必这样,可以直接插入文档,es可以根据插入的文档(数据),动态的创建映射(表结构),这就

IP数据报格式

1、报文格式前几篇总结过较多网络层的知识,ARP,ip地址、子网掩码等等。这次总结一下IP数据报的报文格式IP数据报的格式能够说明IP协议都具有什么功能。在TCP/IP的标准中,各种数据格式常常以32位(4字节)为单位来描述的。wireshark中IP数据报文呈现一个IP数据报文由首部和数据两部分组成。首部的前一部分是固定长度,共20字节。是所有IP数据报文必须具有的。在首部的固定部分的后面是一些可选字段,其长度可变。2、首部个字段意义  1、版本占4位,指IP协议的版本。通信双方使用的IP协议的版本必须一致。目前广泛使用的IP协议版本号为4(即IPv4)。版本号为6(即IPv6)  2、首部

安装 ri 文档时 Ruby gem 失败

我正在尝试在我的Debian6.0.4机器上安装GitLabHQ。这是2012年4月13日的全新安装。现在我已经到了需要由Rubygem完成一些安装的地步。特别是:geminstallbundler这揭示了以下错误:Successfullyinstalledbundler-1.1.31geminstalledInstallingridocumentationforbundler-1.1.3...ERROR:Whileexecutinggem...(ArgumentError)undefinedclass/moduleEncoding然后我尝试重建Ruby包gempristine--al

ruby - 如何将 float 格式化为一定数量的小数和整数?

我正在尝试将Ruby中的float格式化为四位数字,包括小数点。例如:1=>01.002.4=>02.401.4455=>01.45现在,我正在尝试按如下方式格式化float:str_result="%.2f"%result这成功地将小数位数限制为两位。我还知道:str_result="%2d"%result它成功地将1转换为01,但丢失了小数位。我试着像这样组合这些:str_result="%2.2f"%result没有明显效果。它与%.2f具有相同的结果。有没有办法强制Ruby将字符串格式化为这种四位数格式? 最佳答案 您可以使

ruby-on-rails - ruby 中的树结构与父子数组格式没有 gem ?

我有一个数组,其中包含这样的项目列表arr=[{:id=>1,:title=>"A",:parent_id=>nil},{:id=>2,:title=>"B",:parent_id=>nil},{:id=>3,:title=>"A1",:parent_id=>1},{:id=>4,:title=>"A2",:parent_id=>1},{:id=>5,:title=>"A11",:parent_id=>3},{:id=>6,:title=>"12",:parent_id=>3},{:id=>7,:title=>"A2=121",:parent_id=>6},{:id=>8,:title

ruby - 格式化日期时间字符串

我需要我的字符串"Wed,26May201714:00:00+0800"格式为2017-05-2614:00:00+0800(可以将其保留为字符串但不是强制性的)。什么是最快的方法? 最佳答案 parse字符串并通过strftime重新格式化它:string='Wed,26May201714:00:00+0800'Time.parse(string).strftime('%F%T%z')#=>"2017-05-2614:00:00+0800" 关于ruby-格式化日期时间字符串,我们在S

ruby-on-rails - 如何使用 Rails 或 Ruby 文档?

我来自C#,最近我开始编写一些RubyonRails应用程序。我最大的问题是文档,因为我发现它极难使用。例如,找出如何从我的Controller调用生成器花了我大约2小时,然后15分钟之后我找到了Rails::Generators.invoke方法来找出我应该传递给这个函数的参数.也许我使用文档的方式不对;首先,我大胆猜测并在Netbeans代码完成中搜索,这几乎没有帮助,然后我在Google中搜索,然后使用API。有经验的Rails程序员可以给我一些建议吗? 最佳答案 如果您是Rails的新手,我建议您先阅读一本书,然后再深入研究

ruby - 不兼容的 marshal 文件格式(无法读取)需要格式版本 4.8; 0.0 给出

我收到以下错误:incompatiblemarshalfileformat(can'tberead)formatversion4.8required;0.0given在这一行:从我的布局文件的这一部分:true%>true%>我以前从来没有遇到过这个问题,网上的解释对我来说太高级了,或者与制作游戏的人有关,我的项目是一个简单的rails应用程序,我昨天才开始。 最佳答案 您尝试过清算Assets吗?bundleexecrakeassets:clean然后重新编译:bundleexecrakeassets:precompile您是否以